Closing API - REST icon

Closing API - REST

1.1.x
(0 reviews)

Specs Service Orders OUT - REST API

The Closing API supports the following endpoints:

Retrieval of a single service order element

GET /rest/v1/service-orders/{serviceOrderId}

This endpoint allowing to GET the detailed information about a specific project referenced by its {projectId}

This endpoint supports GET operation and can take the following query parameters:

  • expandSpecificData
  • expandTextData
  • expandPartnerData

This endpoint requires the next HTTP headers

Content-type: application/json
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

The payload returned by the GET operation has the following format:


  "header": {
    "apiName": "s-api-myAPI",
    "apiVersion": "1.0",
    "correlationId": "ab7cdcd7-b71a-4554-87e8-61bdea42ab28"
  },
  "data": {
    "sourceId": "string",
    "serviceOrderHeader": {
      "sourceSystem": "string",
      "orderNumber": "string",
      "customerNumber": "string",
      "functLocationLable": "string",
      "equipmentNumber": "string",
      "notificationNumber": "string",
      "description": "string",
      "orderType": "string",
      "systemStatusLine": "string",
      "userStatusLine": "string",
      "maintenanceActivityType": "string",
      "companyCode": "string",
      "controllingArea": "string",
      "businessArea": "string",
      "estimatedTotalOrderCost": "string",
      "currencyKey": "string",
      "priority": "string",
      "schedulingType": "string",
      "scheduledStartDate": "2024-01-01",
      "scheduledStartTime": "08:00:00",
      "scheduledEndDate": "2024-01-02",
      "scheduledEndTime": "17:00:00",
      "earliestStartDate": "2024-01-01",
      "earliestStartTime": "08:00:00",
      "latestFinishDate": "2024-01-03",
      "latestFinishTime": "17:00:00",
      "workCenter": "string",
      "numberSuperiorOrder": "string",
      "plant": "string",
      "businessUnit": "string",
      "sysCondition": "string",
      "languageCode": "string",
      "permissibleOrderType": "string",
      "refurbishmentOorderInd": "string",
      "maintenanceOrderInd": "string",
      "plannerGroup": "string",
      "actualStartDate": "2024-01-01",
      "actualEndDate": "2024-01-02",
      "maintenancePlant": "string",
      "maintenancePlanPlant": "string",
      "workCenterLocation": "string",
      "plannedStartDate": "2024-01-01",
      "plannedEndDate": "2024-01-02",
      "subCategory": "string",
      "attribute1": "string",
      "attribute2": "string",
      "attribute3": "string",
      "reporter": "string",
      "reportDate": "2024-01-01"
    },
    "headerLongText": [
      {
        "tagColumn": "string",
        "textLine": "string"
      }
    ],
    "serviceOrderSpecificData": {
      "assignementType": "string",
      "projectNumber": "string",
      "settlementType": "string",
      "settlementPercentageRate": "string",
      "salesOrderNumber": "string",
      "salesOrderItem": "string",
      "customerOrderNumber": "string",
      "customerOrderDate": "2024-01-01",
      "dipProfile": "string",
      "statusSystem": "string",
      "statusUser": "string",
      "actualStartDate": "2024-01-01",
      "actualEndDate": "2024-01-02",
      "nonCompletionCode": "string",
      "tpControlRoomOrig": "string",
      "tagColumn": "string",
      "textLine": "string"
    },
    "serviceOrderAddress": {
      "title": "string",
      "name1": "string",
      "name2": "string",
      "name3": "string",
      "name4": "string",
      "houseNumber": "string",
      "street": "string",
      "city": "string",
      "district": "string",
      "region": "string",
      "postalCode": "string",
      "countryKey": "string",
      "firstPhoneNumber": "string",
      "languageCode": "string",
      "location": "string"
    },
    "serviceOrderPartner": [
      {
        "partnerFunction": "string",
        "partner": "string",
        "description": "string",
        "languageCode": "string",
        "partnerAddressLanguageCode": "string"
      }
    ],
    "operationMaterial": [
      {
        "stockType": "string",
        "description": "string",
        "stockQuantity": "string"
      }
    ]
  },
  "error": {}
}

Retrieval of the multiple service orders elements

GET /rest/v1/service-orders

Reviews